Skip to content

Set/Unset Platform Alert

Request

Sets Platform Alert state.
Can be used to both set/enable the Platform Alert as well as to unset/disable it.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
activebooleanrequired
titlestringrequired
bodystringrequired
silentbooleanrequired

Send notification to subscribers

curl -i -X POST \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/platform_alert?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "active": true,
    "title": "string",
    "body": "string",
    "silent": true
  }'

Responses

OK

Bodyapplication/json
activeboolean
titlestring
bodystring
silentboolean

Send notification to subscribers

Response
{
  "active": true,
  "title": "string",
  "body": "string",
  "silent": true
}